GET
/
v1
/
receiving
/
{type}
/
{id}
Get one Delivery
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/receiving/{type}/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resource": {
    "type": "ASN",
    "id": 123,
    "supplier_name": "<string>",
    "expected_at": "2019-12-03T21:06:26Z",
    "merchant_reference": "<string>",
    "supplier_invoice_reference": "<string>",
    "supplier_order_reference": "<string>",
    "shipment_type": "international_maritime_freight",
    "bill_of_lading": "<string>",
    "standard_carrier_alpha_code": "<string>",
    "warehouse": {
      "type": "Warehouse",
      "id": 123
    },
    "merchant": {
      "type": "Merchant",
      "id": 4
    },
    "increment_id": "11000020",
    "state": "new",
    "status": "new",
    "progress_percent": 50,
    "carrier_name": "<string>",
    "delivered_at": "2019-12-03T21:06:26Z",
    "receive_by": "2019-12-03T21:06:26Z",
    "processed_at": "2019-12-03T21:06:26Z",
    "putaway_at": "2019-12-03T21:06:26Z",
    "completed_at": "2019-12-03T21:06:26Z",
    "ready_to_process_at": "2019-12-03T21:06:26Z",
    "merchant_status": "<string>",
    "item_count": 123,
    "container_count": 123,
    "label_count": 123,
    "exception_count": 123,
    "processing_comments": "<string>",
    "special_requirements": [
      "<string>"
    ],
    "is_auto_commit": true,
    "created_at": "2017-07-21T17:32:28Z",
    "updated_at": "2017-07-21T17:39:43Z",
    "tracking_numbers": [
      {
        "type": "DeliveryTrackingNumber",
        "id": 123,
        "tracking_number": "<string>"
      }
    ],
    "status_history": [
      {
        "delivery_item": {
          "type": "DeliveryItem",
          "id": 3,
          "delivery": {},
          "qty": 123,
          "qty_expected": 123,
          "qty_received": 123,
          "qty_shortage": 123,
          "qty_overage": 123,
          "qty_processed": 123,
          "qty_putaway": 123,
          "qty_committed": 123,
          "qty_returned": 123,
          "is_sku_merge_email_sent": true,
          "lots": [
            "<any>"
          ],
          "locations": [
            "<any>"
          ],
          "exceptions": [
            "<any>"
          ]
        },
        "status": "new",
        "exception": {
          "type": "Exception",
          "id": 123
        },
        "exception_status": "new",
        "comment": "<string>",
        "user": {
          "type": "OrganizationUser",
          "id": 3
        },
        "created_at": "2017-07-21T17:32:28Z",
        "package": {
          "type": "Package",
          "id": 123
        }
      }
    ]
  },
  "included": {
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "status": "active",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      }
    ],
    "Warehouse": [
      {
        "type": "Warehouse",
        "id": 3,
        "name": "East Coast 1",
        "is_active": true
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

type
enum<string>
required

Specify the delivery type to which your operations will be restricted.

Available options:
asn,
rma
id
integer
required

The id of the referenced Delivery.

Required range: x >= 1

Query Parameters

fields:merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

fields:warehouse
enum<string>[]

Specify additional fields of the Warehouse object to be included in the response. See the selecting fields page for more information.

Response

OK

resource
object

An ASN (Advanced Shipping Notification) delivery object.

included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.